Repository navigation
docs(aigw): workspace_id is a required UUID, and how to find it - #1153
Merged
Merged
Conversation
The Admin API docs said a workspace slug works for workspace_id and that leaving it out falls back to the default workspace. Neither is true: an organisation-scoped access token needs workspace_id, and it must be the workspace's UUID, which the console doesn't show next to the slug. - admin-api/introduction: the first-request curl now sends workspace_id; scoping section corrected (required, UUID, query parameter on every method); new "Find a workspace's ID" section using the Workspace Service; Workspace Service added to the base URL table - workspaces: new "Workspace IDs" section, slug vs UUID, and the Workspace Service for creating and updating workspaces - error, help-center permissions, enforce-default-config: same correction where they repeated the old claims - org-management: the Workspaces card pointed at Portkey's endpoint - docs.json: API nav synced from PaloAltoNetworks/openapi, adding the Workspaces group and the Messages, Access Policies and Egress Allowlist groups Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The curl examples still contradict the corrected guidance by using non-UUID workspace IDs and placing the provider POST’s workspace_id in the body instead of the query string.
1 open issue
What changed in this PR
This PR corrects Prisma AIRS Admin API documentation to require workspace UUIDs in query parameters and explains how to find them.
Changes:
- Corrects workspace-scoping guidance and selected request examples.
- Adds UUID lookup instructions through the Workspace Service and console URL.
- Updates API navigation and fixes the Workspaces card link.
| File | Description |
|---|---|
docs.json |
Adds API groups and analytics endpoints. |
aigw/product/enterprise-offering/org-management/workspaces.mdx |
Explains UUIDs versus slugs and Workspace Service operations. |
aigw/product/enterprise-offering/org-management.mdx |
Links the Workspaces card to the AIRS page. |
aigw/product/administration/enforce-default-config.mdx |
Moves workspace scoping into the example’s query string. |
aigw/help-center/you-do-not-have-enough-permissions.mdx |
Corrects workspace-scoping troubleshooting guidance. |
aigw/api-reference/admin-api/introduction.mdx |
Documents required UUID scoping and workspace lookup methods. |
aigw/api-reference/admin-api/error.mdx |
Corrects workspace parameters in error-resolution guidance. |
Review effort: Balanced
…y string Addresses review: the two curl examples under the corrected note still used a ws-abc123 slug, and the provider POST still put workspace_id in the body. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
roh26it
approved these changes
Nov 3, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
From a customer thread: Admin API calls such as configs and guardrails, made with an SCM service-account token, need
workspace_idas a UUID. Our docs said the opposite in three ways:workspace_idout falls back to the default workspaceThe UUID also isn't shown anywhere next to the slug in the console.
What
admin-api/introduction.mdx?workspace_id=<workspace_uuid>.workspace_idis required, it's the UUID, and it goes in the query string on every method.GET /workspaces?exact_name=…on the Workspace Service, or copy the UUID from the console URL.org-management/workspaces.mdxerror.mdx,help-center/you-do-not-have-enough-permissions.mdx,enforce-default-config.mdx: these repeated the same old claims and are corrected the same way.org-management.mdx: the Workspaces card linked to Portkey's endpoint docs. It now links to our Workspaces page.docs.json: API navigation synced from PaloAltoNetworks/openapi withsync_api_nav.py. This adds the new Workspaces group, plus Messages, Access Policies and Egress Allowlist from openapi#6.Merge order
Merge PaloAltoNetworks/openapi#7 first. The new
/aigw/api-reference/workspaces/*pages are generated from it.Checks
check_nav_page_parity.py: OKcheck_anchors.py: the same known failures as main, nothing newcheck_prose_endpoints.py: the remaining items are existing ones incas.mdxand stale allow-list entries, nothing from this change🤖 Generated with Claude Code